<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.core.common_reader</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.core-module.html">Package&nbsp;core</a> ::
        Module&nbsp;common_reader
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="simvoc.core.common_reader-module.html">Module simvoc.core.common_reader</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment"># Routines for reading simulator data files in the common format produced</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment"># by the common_writer input module.</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"># Author:   Mike Murphy &lt;mamurph@cs.clemson.edu&gt;</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment"># Revision: 23 September 2009</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-comment">#   Copyright 2009 Clemson University</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-comment">#   Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-comment">#   you may not use this file except in compliance with the License.</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-comment">#   You may obtain a copy of the License at</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-comment">#       http://www.apache.org/licenses/LICENSE-2.0</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-comment">#   Unless required by applicable law or agreed to in writing, software</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-comment">#   distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-comment">#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-comment">#   See the License for the specific language governing permissions and</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-comment">#   limitations under the License.</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-comment"># This material is based upon work supported under a National Science</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-comment"># Foundation Graduate Research Fellowship. Any opinions, findings,</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-comment"># conclusions or recommendations expressed in this publication are those of</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-comment"># the author(s) and do not necessarily reflect the views of the National</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-comment"># Science Foundation.</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">Common routines for reading simulator input files in the common format</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">produced by simvoc.input.common_writer. This module implements handlers</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">for the elements that are common to all format types, such as metadata,</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">while subclasses will add handlers for specific input formats.</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module simvoc.core.results=simvoc.core.results-module.html"><a title="simvoc.core.results" class="py-name" href="#" onclick="return doclink('link-0', 'results', 'link-0');">results</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Class simvoc.core.results.MetadataResult=simvoc.core.results.MetadataResult-class.html"><a title="simvoc.core.results.MetadataResult" class="py-name" href="#" onclick="return doclink('link-1', 'MetadataResult', 'link-1');">MetadataResult</a></tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"> </tt>
<a name="ReaderException"></a><div id="ReaderException-def"><a name="L39"></a><tt class="py-lineno"> 39</tt> <a class="py-toggle" href="#" id="ReaderException-toggle" onclick="return toggle('ReaderException');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.common_reader.ReaderException-class.html">ReaderException</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ReaderException-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ReaderException-expanded"><a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">   Exception thrown when scan or parse errors occur in an input file</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line">   <tt class="py-keyword">pass</tt> </tt>
</div><a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"> </tt>
<a name="CommonReader"></a><div id="CommonReader-def"><a name="L47"></a><tt class="py-lineno"> 47</tt> <a class="py-toggle" href="#" id="CommonReader-toggle" onclick="return toggle('CommonReader');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html">CommonReader</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="CommonReader-expanded"><a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">   Implements a common scanner and parser for the simulator input formats</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">   written by simvoc.input.common_writer. This base class handles basic</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">   file syntax checking, comment stripping, format number checking, clock</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">   lines, and metadata. In addition, this implementation automatically</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">   schedules the parsing of clock blocks at the appropriate times specified</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">   by the clock lines. Subclasses will add parse handlers and extend the</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">   parser map to handle commands specific to different types of files.</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">   Errors and warnings delivered by this class and its subclasses will be</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">   in a format similar to those produced by gcc(1), containing the filename</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">   and line number that triggers the error. In some cases, simulation errors</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">   may result from problems with the input data. Unfortunately, these types</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">   of errors will not have source information.</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="CommonReader.__init__"></a><div id="CommonReader.__init__-def"><a name="L63"></a><tt class="py-lineno"> 63</tt> <a class="py-toggle" href="#" id="CommonReader.__init__-toggle" onclick="return toggle('CommonReader.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">fh</tt><tt class="py-op">,</tt> <tt class="py-param">simobj</tt><tt class="py-op">,</tt> <tt class="py-param">fmt_num</tt><tt class="py-op">,</tt> <tt class="py-param">prefix</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.__init__-expanded"><a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">      @param filename: Name of the open input file</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">      @type filename: str</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">      @param fh: Handle to the open input file (r mode)</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring">      @param simobj: Reference to the simulator object</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">      @param fmt_num: Format number of the input file, to be checked against</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">                    any "format" commands inside the file. When formats do not</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">                    match, a warning will be generated.</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">      @type fmt_num: float</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">      @param prefix: Prefix to add to metadata fields when creating metadata</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">                     results for the simulator</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">      @type prefix: str</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">filename</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fh</tt> <tt class="py-op">=</tt> <tt class="py-name">fh</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt> <tt class="py-op">=</tt> <tt class="py-name">simobj</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fmt_num</tt> <tt class="py-op">=</tt> <tt class="py-name">fmt_num</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-name">prefix</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clock_seen</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">eof</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line_number</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parse_map</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-string">'format'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.h_format()=simvoc.core.common_reader.CommonReader-class.html#h_format"><a title="simvoc.core.common_reader.CommonReader.h_format" class="py-name" href="#" onclick="return doclink('link-2', 'h_format', 'link-2');">h_format</a></tt><tt class="py-op">,</tt> <tt class="py-string">'meta'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.h_meta()=simvoc.core.common_reader.CommonReader-class.html#h_meta"><a title="simvoc.core.common_reader.CommonReader.h_meta" class="py-name" href="#" onclick="return doclink('link-3', 'h_meta', 'link-3');">h_meta</a></tt><tt class="py-op">,</tt> \ </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line">                         <tt class="py-string">'clock'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.h_clock()=simvoc.core.common_reader.CommonReader-class.html#h_clock"><a title="simvoc.core.common_reader.CommonReader.h_clock" class="py-name" href="#" onclick="return doclink('link-4', 'h_clock', 'link-4');">h_clock</a></tt><tt class="py-op">,</tt> <tt class="py-string">'version'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.h_version()=simvoc.core.common_reader.CommonReader-class.html#h_version"><a title="simvoc.core.common_reader.CommonReader.h_version" class="py-name" href="#" onclick="return doclink('link-5', 'h_version', 'link-5');">h_version</a></tt><tt class="py-op">,</tt> \ </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">                         <tt class="py-string">'epoch'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.h_epoch()=simvoc.core.common_reader.CommonReader-class.html#h_epoch"><a title="simvoc.core.common_reader.CommonReader.h_epoch" class="py-name" href="#" onclick="return doclink('link-6', 'h_epoch', 'link-6');">h_epoch</a></tt> <tt class="py-op">}</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch_seen</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata_results_posted</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.parse()=simvoc.core.common_reader.CommonReader-class.html#parse,Method simvoc.input.mod_ldif.LDIFParser.parse()=simvoc.input.mod_ldif.LDIFParser-class.html#parse"><a title="simvoc.core.common_reader.CommonReader.parse
simvoc.input.mod_ldif.LDIFParser.parse" class="py-name" href="#" onclick="return doclink('link-7', 'parse', 'link-7');">parse</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line">      <tt class="py-comment">#</tt> </tt>
<a name="CommonReader.add_handler"></a><div id="CommonReader.add_handler-def"><a name="L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="CommonReader.add_handler-toggle" onclick="return toggle('CommonReader.add_handler');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#add_handler">add_handler</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">cmd</tt><tt class="py-op">,</tt> <tt class="py-param">handler</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.add_handler-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.add_handler-expanded"><a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">      Adds a parse handler to support new commands. This method is used by</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"><tt class="py-docstring">      subclasses to extend the parser.</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">      @param cmd: Command to handle</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-docstring">      @type cmd: str</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring">      @param handler: Handler method to invoke when the command is seen</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parse_map</tt><tt class="py-op">[</tt><tt class="py-name">cmd</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">handler</tt> </tt>
</div><a name="CommonReader.error"></a><div id="CommonReader.error-def"><a name="L110"></a><tt class="py-lineno">110</tt> <a class="py-toggle" href="#" id="CommonReader.error-toggle" onclick="return toggle('CommonReader.error');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#error">error</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.error-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.error-expanded"><a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">      Uniform mechanism for producing error messages (ReaderExceptions) with</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">      filename and line number information. This method automatically adds</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"><tt class="py-docstring">      the location information, so the error message passed to this method</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring">      should be "plain" (without filename or line number).</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">      @param msg: Error message to include</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">      @type msg: str</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line">      <tt class="py-keyword">raise</tt> <tt id="link-8" class="py-name" targets="Class simvoc.core.common_reader.ReaderException=simvoc.core.common_reader.ReaderException-class.html"><a title="simvoc.core.common_reader.ReaderException" class="py-name" href="#" onclick="return doclink('link-8', 'ReaderException', 'link-8');">ReaderException</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s:%d: error: %s'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line">         <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line_number</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line">      <tt class="py-comment">#</tt> </tt>
<a name="CommonReader.warning"></a><div id="CommonReader.warning-def"><a name="L123"></a><tt class="py-lineno">123</tt> <a class="py-toggle" href="#" id="CommonReader.warning-toggle" onclick="return toggle('CommonReader.warning');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#warning">warning</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.warning-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.warning-expanded"><a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring">      Uniform mechanism for raising a warning when conditions exist in the</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-docstring">      input file that do not necessarily constitute an error. Location</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-docstring">      information (filename and line number) are added automatically.</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring">      @param msg: Warning message to include</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring">      @type msg: str</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">      <tt class="py-keyword">raise</tt> <tt class="py-name">Warning</tt><tt class="py-op">(</tt><tt class="py-string">'%s:%d: warning: %s'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line">         <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line_number</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line">      <tt class="py-comment">#</tt> </tt>
<a name="CommonReader.scan"></a><div id="CommonReader.scan-def"><a name="L135"></a><tt class="py-lineno">135</tt> <a class="py-toggle" href="#" id="CommonReader.scan-toggle" onclick="return toggle('CommonReader.scan');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#scan">scan</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.scan-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.scan-expanded"><a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">      Implements the scanner portion of the common format reader. This method</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">      is invoked automatically by the parse() method and sets the current</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">      scan line (self.line) and token list (self.parts).</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: bool</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True if there is more data in the input file, False if the</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">               reader has reached EOF</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line">      <tt class="py-keyword">while</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">eof</tt><tt class="py-op">:</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line">         <tt class="py-name">raw</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fh</tt><tt class="py-op">.</tt><tt class="py-name">readline</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line">         <tt class="py-keyword">if</tt> <tt class="py-name">raw</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt>   <tt class="py-comment"># EOF</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">eof</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line">         <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">raw</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'#'</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'\\P'</tt><tt class="py-op">,</tt> <tt class="py-string">'#'</tt><tt class="py-op">)</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line</tt> <tt class="py-op">!=</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line">               <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line_number</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">eof</tt> </tt>
</div><a name="CommonReader.parse"></a><div id="CommonReader.parse-def"><a name="L157"></a><tt class="py-lineno">157</tt> <a class="py-toggle" href="#" id="CommonReader.parse-toggle" onclick="return toggle('CommonReader.parse');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#parse">parse</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.parse-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.parse-expanded"><a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line"><tt class="py-docstring">      Main parser loop, invoked by the trigger() method. The parser loop runs,</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"><tt class="py-docstring">      invoking the scanner and parse handlers as needed, until a parse handler</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line"><tt class="py-docstring">      returns False or EOF is reached. In general, only h_clock() ever returns</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line"><tt class="py-docstring">      False, to indicate that parsing of the current clock block is complete.</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">      <tt id="link-9" class="py-name" targets="Method simvoc.core.kernel.Simulator.run()=simvoc.core.kernel.Simulator-class.html#run,Method simvoc.core.voc_sim.VMPilot.run()=simvoc.core.voc_sim.VMPilot-class.html#run"><a title="simvoc.core.kernel.Simulator.run
simvoc.core.voc_sim.VMPilot.run" class="py-name" href="#" onclick="return doclink('link-9', 'run', 'link-9');">run</a></tt> <tt class="py-op">=</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">eof</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">      <tt class="py-keyword">while</tt> <tt id="link-10" class="py-name"><a title="simvoc.core.kernel.Simulator.run
simvoc.core.voc_sim.VMPilot.run" class="py-name" href="#" onclick="return doclink('link-10', 'run', 'link-9');">run</a></tt><tt class="py-op">:</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line">         <tt id="link-11" class="py-name"><a title="simvoc.core.kernel.Simulator.run
simvoc.core.voc_sim.VMPilot.run" class="py-name" href="#" onclick="return doclink('link-11', 'run', 'link-9');">run</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.scan()=simvoc.core.common_reader.CommonReader-class.html#scan"><a title="simvoc.core.common_reader.CommonReader.scan" class="py-name" href="#" onclick="return doclink('link-12', 'scan', 'link-12');">scan</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">         <tt class="py-keyword">if</tt> <tt id="link-13" class="py-name"><a title="simvoc.core.kernel.Simulator.run
simvoc.core.voc_sim.VMPilot.run" class="py-name" href="#" onclick="return doclink('link-13', 'run', 'link-9');">run</a></tt><tt class="py-op">:</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line">            <tt class="py-name">cmd</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">cmd</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parse_map</tt><tt class="py-op">:</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line">               <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.error()=simvoc.core.common_reader.CommonReader-class.html#error"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-14', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unknown command: '</tt> <tt class="py-op">+</tt> <tt class="py-name">cmd</tt><tt class="py-op">)</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line">            <tt id="link-15" class="py-name"><a title="simvoc.core.kernel.Simulator.run
simvoc.core.voc_sim.VMPilot.run" class="py-name" href="#" onclick="return doclink('link-15', 'run', 'link-9');">run</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parse_map</tt><tt class="py-op">[</tt><tt class="py-name">cmd</tt><tt class="py-op">]</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line">         <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line">            <tt class="py-comment"># At EOF: dump metadata if we have not yet done so</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata_results_posted</tt><tt class="py-op">:</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line">               <tt class="py-keyword">for</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">:</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line">                  <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prefix</tt> <tt class="py-op">+</tt> <tt class="py-name">key</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line">                  <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line">                  <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method simvoc.core.kernel.Simulator.add_result()=simvoc.core.kernel.Simulator-class.html#add_result"><a title="simvoc.core.kernel.Simulator.add_result" class="py-name" href="#" onclick="return doclink('link-16', 'add_result', 'link-16');">add_result</a></tt><tt class="py-op">(</tt><tt id="link-17" class="py-name"><a title="simvoc.core.results.MetadataResult" class="py-name" href="#" onclick="return doclink('link-17', 'MetadataResult', 'link-1');">MetadataResult</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line">               <tt class="py-comment">#</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line">               <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">version</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line">                  <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prefix</tt> <tt class="py-op">+</tt> <tt class="py-string">'version'</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line">                  <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">version</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line">                  <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="simvoc.core.kernel.Simulator.add_result" class="py-name" href="#" onclick="return doclink('link-18', 'add_result', 'link-16');">add_result</a></tt><tt class="py-op">(</tt><tt id="link-19" class="py-name"><a title="simvoc.core.results.MetadataResult" class="py-name" href="#" onclick="return doclink('link-19', 'MetadataResult', 'link-1');">MetadataResult</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line">               <tt class="py-comment">#</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">               <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata_results_posted</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">         <tt class="py-comment">#</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">      <tt class="py-comment">#</tt> </tt>
<a name="CommonReader.h_format"></a><div id="CommonReader.h_format-def"><a name="L188"></a><tt class="py-lineno">188</tt> <a class="py-toggle" href="#" id="CommonReader.h_format-toggle" onclick="return toggle('CommonReader.h_format');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#h_format">h_format</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.h_format-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.h_format-expanded"><a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line"><tt class="py-docstring">      Parse handler for the "format" command. Raises a warning if the format</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line"><tt class="py-docstring">      of the input file does not match the format number set in the</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-docstring">      constructor.</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-20', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'format command takes exactly 1 argument'</tt><tt class="py-op">)</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line">      <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line">         <tt class="py-name">fmt</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line">      <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-21', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">fmt</tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fmt_num</tt><tt class="py-op">:</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.warning()=simvoc.core.common_reader.CommonReader-class.html#warning"><a title="simvoc.core.common_reader.CommonReader.warning" class="py-name" href="#" onclick="return doclink('link-22', 'warning', 'link-22');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'format %s differs from reader version %s'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line">         <tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">fmt</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fmt_num</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="CommonReader.h_meta"></a><div id="CommonReader.h_meta-def"><a name="L206"></a><tt class="py-lineno">206</tt> <a class="py-toggle" href="#" id="CommonReader.h_meta-toggle" onclick="return toggle('CommonReader.h_meta');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#h_meta">h_meta</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.h_meta-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.h_meta-expanded"><a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line"><tt class="py-docstring">      Parse handler for metadata. Each metadata item is added to the</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line"><tt class="py-docstring">      instance metadata dictionary (self.metadata).</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">      <tt class="py-name">metacmd</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line">      <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-name">metacmd</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">)</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-23', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'malformed meta statement'</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line">      <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">parts</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">metadata</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="CommonReader.h_version"></a><div id="CommonReader.h_version-def"><a name="L220"></a><tt class="py-lineno">220</tt> <a class="py-toggle" href="#" id="CommonReader.h_version-toggle" onclick="return toggle('CommonReader.h_version');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#h_version">h_version</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.h_version-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.h_version-expanded"><a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line"><tt class="py-docstring">      Parse handler for file version number.</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-24', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'version command takes exactly 1 argument'</tt><tt class="py-op">)</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line">      <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line">      <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-25', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="CommonReader.h_epoch"></a><div id="CommonReader.h_epoch-def"><a name="L233"></a><tt class="py-lineno">233</tt> <a class="py-toggle" href="#" id="CommonReader.h_epoch-toggle" onclick="return toggle('CommonReader.h_epoch');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#h_epoch">h_epoch</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.h_epoch-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.h_epoch-expanded"><a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line"><tt class="py-docstring">      Parse handler for the epoch statement, which allows multiple input</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line"><tt class="py-docstring">      files with normalized times to be used in the same simulation. An epoch</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line"><tt class="py-docstring">      statement may only occur once in the file, and it must occur before the</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line"><tt class="py-docstring">      first clock line.</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-26', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'epoch statement takes exactly 1 argument'</tt><tt class="py-op">)</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch_seen</tt><tt class="py-op">:</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-27', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'epoch statement may only occur once in a file'</tt><tt class="py-op">)</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clock_seen</tt><tt class="py-op">:</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-28', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'epoch statement must occur before first clock line'</tt><tt class="py-op">)</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line">      <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line">         <tt class="py-name">ef</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line">         <tt class="py-name">ei</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">ef</tt><tt class="py-op">)</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch</tt> <tt class="py-op">=</tt> <tt class="py-name">ef</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line">         <tt class="py-keyword">if</tt> <tt class="py-name">ei</tt> <tt class="py-op">==</tt> <tt class="py-name">ef</tt><tt class="py-op">:</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch</tt> <tt class="py-op">=</tt> <tt class="py-name">ei</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch_seen</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line">      <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-29', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="CommonReader.h_clock"></a><div id="CommonReader.h_clock-def"><a name="L258"></a><tt class="py-lineno">258</tt> <a class="py-toggle" href="#" id="CommonReader.h_clock-toggle" onclick="return toggle('CommonReader.h_clock');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#h_clock">h_clock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.h_clock-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.h_clock-expanded"><a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line"><tt class="py-docstring">      Parse handler for clock lines. Upon reading a clock line, this handler</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line"><tt class="py-docstring">      will schedule a trigger() method invocation for the time specified by</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line"><tt class="py-docstring">      the clock line.</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-docstring">      @return: False</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-30', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'clock command takes exactly 1 argument'</tt><tt class="py-op">)</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line">      <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line">         <tt class="py-name">tsf</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line">      <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">:</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="simvoc.core.common_reader.CommonReader.error" class="py-name" href="#" onclick="return doclink('link-31', 'error', 'link-14');">error</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line">      <tt class="py-name">tsi</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">tsf</tt><tt class="py-op">)</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line">      <tt class="py-name">timestamp</tt> <tt class="py-op">=</tt> <tt class="py-name">tsf</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">tsi</tt> <tt class="py-op">==</tt> <tt class="py-name">tsf</tt><tt class="py-op">:</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line">         <tt class="py-name">timestamp</tt> <tt class="py-op">=</tt> <tt class="py-name">tsi</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.add_trigger()=simvoc.core.common_reader.CommonReader-class.html#add_trigger"><a title="simvoc.core.common_reader.CommonReader.add_trigger" class="py-name" href="#" onclick="return doclink('link-32', 'add_trigger', 'link-32');">add_trigger</a></tt><tt class="py-op">(</tt><tt class="py-name">timestamp</tt><tt class="py-op">)</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clock_seen</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="CommonReader.in_clock_block"></a><div id="CommonReader.in_clock_block-def"><a name="L279"></a><tt class="py-lineno">279</tt> <a class="py-toggle" href="#" id="CommonReader.in_clock_block-toggle" onclick="return toggle('CommonReader.in_clock_block');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#in_clock_block">in_clock_block</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.in_clock_block-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.in_clock_block-expanded"><a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True iff at least one clock line has been parsed, allowing</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line"><tt class="py-docstring">               routines to ensure that the current command is inside a clock</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line"><tt class="py-docstring">               block</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clock_seen</tt> </tt>
</div><a name="CommonReader.add_trigger"></a><div id="CommonReader.add_trigger-def"><a name="L286"></a><tt class="py-lineno">286</tt> <a class="py-toggle" href="#" id="CommonReader.add_trigger-toggle" onclick="return toggle('CommonReader.add_trigger');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#add_trigger">add_trigger</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">time</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.add_trigger-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.add_trigger-expanded"><a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line"><tt class="py-docstring">      Adds a new parse trigger as a simulator event scheduled for a time not</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line"><tt class="py-docstring">      in the past. Only one trigger event may be active at a time: adding a</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line"><tt class="py-docstring">      second trigger will result in an Exception being raised.</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line"><tt class="py-docstring">      @param time: Time at which the parse trigger will be invoked, subject</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line"><tt class="py-docstring">                   to automatic offset</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line"><tt class="py-docstring">      @type time: number</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line">         <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'Only 1 trigger event may be pending at any time'</tt><tt class="py-op">)</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt> <tt class="py-op">=</tt> \ </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name" targets="Method simvoc.core.kernel.EventQueue.new_simple_event()=simvoc.core.kernel.EventQueue-class.html#new_simple_event,Method simvoc.core.kernel.Simulator.new_simple_event()=simvoc.core.kernel.Simulator-class.html#new_simple_event"><a title="simvoc.core.kernel.EventQueue.new_simple_event
simvoc.core.kernel.Simulator.new_simple_event" class="py-name" href="#" onclick="return doclink('link-33', 'new_simple_event', 'link-33');">new_simple_event</a></tt><tt class="py-op">(</tt><tt class="py-name">time</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">offset</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.trigger()=simvoc.core.common_reader.CommonReader-class.html#trigger"><a title="simvoc.core.common_reader.CommonReader.trigger" class="py-name" href="#" onclick="return doclink('link-34', 'trigger', 'link-34');">trigger</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="CommonReader.trigger"></a><div id="CommonReader.trigger-def"><a name="L300"></a><tt class="py-lineno">300</tt> <a class="py-toggle" href="#" id="CommonReader.trigger-toggle" onclick="return toggle('CommonReader.trigger');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#trigger">trigger</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">time</tt><tt class="py-op">,</tt> <tt class="py-param">simobj</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.trigger-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.trigger-expanded"><a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line"><tt class="py-docstring">      Parse trigger: a simulator-aware function that invokes the parser to</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring">      handle the next clock block.</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring">      @param time: Current simulated time</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-docstring">      @type time: number</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"><tt class="py-docstring">      @param simobj: Reference to the simulator object</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="simvoc.core.common_reader.CommonReader.parse
simvoc.input.mod_ldif.LDIFParser.parse" class="py-name" href="#" onclick="return doclink('link-35', 'parse', 'link-7');">parse</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="CommonReader.get_epoch"></a><div id="CommonReader.get_epoch-def"><a name="L312"></a><tt class="py-lineno">312</tt> <a class="py-toggle" href="#" id="CommonReader.get_epoch-toggle" onclick="return toggle('CommonReader.get_epoch');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#get_epoch">get_epoch</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.get_epoch-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.get_epoch-expanded"><a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: number</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line"><tt class="py-docstring">      @return: epoch value found in the input file (defaults to zero if</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line"><tt class="py-docstring">               not present)</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch</tt> </tt>
</div><a name="CommonReader.set_offset"></a><div id="CommonReader.set_offset-def"><a name="L319"></a><tt class="py-lineno">319</tt> <a class="py-toggle" href="#" id="CommonReader.set_offset-toggle" onclick="return toggle('CommonReader.set_offset');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#set_offset">set_offset</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.set_offset-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.set_offset-expanded"><a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line"><tt class="py-docstring">      Sets the clock block time offset, used in cases where multiple input</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line"><tt class="py-docstring">      files with normalized times are used in the same simulation (see the</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line"><tt class="py-docstring">      set_normalization() method).</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line"><tt class="py-docstring">      @param offset: New offset value</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line"><tt class="py-docstring">      @type offset: number</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">offset</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line">         <tt class="py-name">time</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method simvoc.core.kernel.EventQueue.cancel_event()=simvoc.core.kernel.EventQueue-class.html#cancel_event,Method simvoc.core.kernel.Simulator.cancel_event()=simvoc.core.kernel.Simulator-class.html#cancel_event"><a title="simvoc.core.kernel.EventQueue.cancel_event
simvoc.core.kernel.Simulator.cancel_event" class="py-name" href="#" onclick="return doclink('link-36', 'cancel_event', 'link-36');">cancel_event</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt><tt class="py-op">)</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending_event</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="simvoc.core.common_reader.CommonReader.add_trigger" class="py-name" href="#" onclick="return doclink('link-37', 'add_trigger', 'link-32');">add_trigger</a></tt><tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">)</tt>   <tt class="py-comment"># offset is added by add_trigger</tt> </tt>
</div><a name="CommonReader.set_normalization"></a><div id="CommonReader.set_normalization-def"><a name="L334"></a><tt class="py-lineno">334</tt> <a class="py-toggle" href="#" id="CommonReader.set_normalization-toggle" onclick="return toggle('CommonReader.set_normalization');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader.CommonReader-class.html#set_normalization">set_normalization</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">normtime</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CommonReader.set_normalization-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="CommonReader.set_normalization-expanded"><a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line"><tt class="py-docstring">      Sets the offset according to the specified normalized time value. This</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line"><tt class="py-docstring">      time value must be the lowest epoch from all data sets, otherwise a</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line"><tt class="py-docstring">      simulation-time Exception will occur.</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line"><tt class="py-docstring">      @param normtime: Earliest timestamp among all data sets</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"><tt class="py-docstring">      @type normtime: number</tt> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line">      <tt class="py-name">diff</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">epoch</tt> <tt class="py-op">-</tt> <tt class="py-name">normtime</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.set_offset()=simvoc.core.common_reader.CommonReader-class.html#set_offset"><a title="simvoc.core.common_reader.CommonReader.set_offset" class="py-name" href="#" onclick="return doclink('link-38', 'set_offset', 'link-38');">set_offset</a></tt><tt class="py-op">(</tt><tt class="py-name">diff</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line"> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"> </tt>
<a name="normalize"></a><div id="normalize-def"><a name="L348"></a><tt class="py-lineno">348</tt> <a class="py-toggle" href="#" id="normalize-toggle" onclick="return toggle('normalize');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.common_reader-module.html#normalize">normalize</a><tt class="py-op">(</tt><tt class="py-param">readers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="normalize-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="normalize-expanded"><a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"><tt class="py-docstring">   Performs a simulation-time normalization on a list of readers, setting</tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line"><tt class="py-docstring">   each reader normalization value to the earliest epoch found among the</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line"><tt class="py-docstring">   list members.</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line"><tt class="py-docstring">   @param readers: List of CommonReader (or child class) objects, each of</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line"><tt class="py-docstring">                   which must already be initialized on an open input file</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line">   <tt class="py-name">early_epoch</tt> <tt class="py-op">=</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line">   <tt class="py-keyword">for</tt> <tt class="py-name">reader</tt> <tt class="py-keyword">in</tt> <tt class="py-name">readers</tt><tt class="py-op">:</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line">      <tt class="py-name">epoch</tt> <tt class="py-op">=</tt> <tt class="py-name">reader</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.get_epoch()=simvoc.core.common_reader.CommonReader-class.html#get_epoch"><a title="simvoc.core.common_reader.CommonReader.get_epoch" class="py-name" href="#" onclick="return doclink('link-39', 'get_epoch', 'link-39');">get_epoch</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">early_epoch</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">epoch</tt> <tt class="py-op">&lt;</tt> <tt class="py-name">early_epoch</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">epoch</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line">         <tt class="py-name">early_epoch</tt> <tt class="py-op">=</tt> <tt class="py-name">epoch</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt class="py-name">early_epoch</tt> <tt class="py-op">&gt;=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line">      <tt class="py-keyword">for</tt> <tt class="py-name">reader</tt> <tt class="py-keyword">in</tt> <tt class="py-name">readers</tt><tt class="py-op">:</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line">         <tt class="py-name">reader</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method simvoc.core.common_reader.CommonReader.set_normalization()=simvoc.core.common_reader.CommonReader-class.html#set_normalization"><a title="simvoc.core.common_reader.CommonReader.set_normalization" class="py-name" href="#" onclick="return doclink('link-40', 'set_normalization', 'link-40');">set_normalization</a></tt><tt class="py-op">(</tt><tt class="py-name">early_epoch</tt><tt class="py-op">)</tt> </tt>
</div><a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:35 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
